boostinv2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

// ----------------------------------------------------------------------------
 
#ifndef BOOSTINV2_H
#define BOOSTINV2_H

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 

 
#define BOOSTINV2_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.en = MIKROBUS( mikrobus, MIKROBUS_AN ); \
   cfg.csn = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.psm = MIKROBUS( mikrobus, MIKROBUS_PWM ); 


#define BOOSTINV2_RETVAL  uint8_t
 
#define BOOSTINV2_OK           0x00
#define BOOSTINV2_INIT_ERROR   0xFF

#define BOOSTINV2_POS_VOUT_5V   0x7FFF
#define BOOSTINV2_POS_VOUT_6V   0x7B00
#define BOOSTINV2_POS_VOUT_7V   0x7A20
#define BOOSTINV2_POS_VOUT_8V   0x7950
#define BOOSTINV2_POS_VOUT_9V   0x7870
#define BOOSTINV2_POS_VOUT_10V  0x7790
#define BOOSTINV2_POS_VOUT_11V  0x76B0
#define BOOSTINV2_POS_VOUT_12V  0x75E0
#define BOOSTINV2_POS_VOUT_13V  0x7500
#define BOOSTINV2_POS_VOUT_14V  0x7420
#define BOOSTINV2_POS_VOUT_15V  0x7340

#define BOOSTINV2_NEG_VOUT_5V    0x79A2
#define BOOSTINV2_NEG_VOUT_6V    0x7900
#define BOOSTINV2_NEG_VOUT_7V    0x786A
#define BOOSTINV2_NEG_VOUT_8V    0x77D0
#define BOOSTINV2_NEG_VOUT_9V    0x7744
#define BOOSTINV2_NEG_VOUT_10V   0x76B0
#define BOOSTINV2_NEG_VOUT_11V   0x7630
#define BOOSTINV2_NEG_VOUT_12V   0x75B2
#define BOOSTINV2_NEG_VOUT_13V   0x7530
#define BOOSTINV2_NEG_VOUT_14V   0x74B0
#define BOOSTINV2_NEG_VOUT_15V   0x7474
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES

typedef struct
{
    // Output pins 
 
    digital_out_t en;
    digital_out_t csn;
    digital_out_t psm;
    digital_out_t cs;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} boostinv2_t;

typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
 
    pin_name_t en;
    pin_name_t csn;
    pin_name_t psm;
 
    // static variable 
 
    uint32_t spi_speed;
    uint8_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} boostinv2_cfg_t;
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS

#ifdef __cplusplus
extern "C"{
#endif

void boostinv2_cfg_setup ( boostinv2_cfg_t *cfg );

BOOSTINV2_RETVAL boostinv2_init ( boostinv2_t *ctx, boostinv2_cfg_t *cfg );

void boostinv2_default_cfg ( boostinv2_t *ctx );

void boostinv2_generic_transfer 
( 
    boostinv2_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len, 
    uint8_t *rd_buf, 
    uint16_t rd_len 
);

void boostinv2_enable ( boostinv2_t *ctx );

void boostinv2_set_positive_voltage ( boostinv2_t *ctx, uint16_t voltage );

void boostinv2_set_negative_voltage ( boostinv2_t *ctx, uint16_t voltage );

void boostinv2_set_psn (  boostinv2_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif  // _BOOSTINV2_H_
 
 // End public_function group

// ------------------------------------------------------------------------- END